// Copyright (c) 2024 PaddlePaddle Authors. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#pragma once

#include <list>
#include <memory>
#include "paddle/ap/include/adt/adt.h"

namespace ap::memory {

class CirclableRefImplBase;

class CirclableRefListBase {
 public:
  CirclableRefListBase(const CirclableRefListBase&) = delete;
  CirclableRefListBase(CirclableRefListBase&&) = delete;
  virtual ~CirclableRefListBase() = default;

  using WeakRefList = std::list<std::weak_ptr<CirclableRefImplBase>>;

  virtual WeakRefList::iterator AddWeakRef(
      const std::shared_ptr<CirclableRefImplBase>& ref) = 0;

  virtual adt::Result<WeakRefList::iterator> EraseWeakRef(
      CirclableRefImplBase* ref) = 0;

 protected:
  CirclableRefListBase() = default;
};

}  // namespace ap::memory
